Weave Loader/net.weavemc.loader.api.event/MouseEvent

MouseEvent

class MouseEvent : CancellableEvent(source)

This cancellable event is called when a mouse action is performed.

If cancelled, the event's actions will not affect the game.

Constructors

MouseEvent

constructor()

Properties

button

val button: Int

The mouse button the event is about.

buttonState

val buttonState: Boolean

Whether the mouse button is being pressed (true) or released (false).

cancelled

@get:JvmName(name = "isCancelled")

var cancelled: Boolean

This field defines whether the event is cancelled or not. Any mod can cancel and un-cancel an event. What an event does when cancelled is event-specific, and noted in that event's documentation.

dwheel

@get:JvmName(name = "getDWheel")

val dwheel: Int

The amount the mouse's scroll wheel has scrolled, negative if scrolling backwards.

@get:JvmName(name = "getDX")

val dx: Int

The X distance the mouse has travelled.

@get:JvmName(name = "getDY")

val dy: Int

The Y distance the mouse has travelled.

nanoseconds

val nanoseconds: Long

The nanosecond that this mouse event was created. Obtained from the mouse event's Mouse.getEventNanoseconds(), refer to the LWJGL2 Javadoc for more information about it.

val x: Int

The mouse's X position on the screen.

val y: Int

The mouse's Y position on the screen.